home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 March / macformat-022.iso / Shareware City / Developers / HoW Developer’s Kit 1.2 / HoWSample / HoWSample Help / HoWSample Help.rsrc / STR#_1028.txt < prev    next >
Encoding:
Text File  |  1994-10-17  |  3.5 KB  |  147 lines
  1. 
  2.  
  3. 
  4.  
  5. ‹
  6.  
  7. ‹
  8.  
  9. √•Language Support
  10.  
  11. 
  12.  
  13. 
  14.  
  15. You may have designed your client application to offer a multilingual user
  16.  
  17. interface in a single international version.  Or perhaps it‚Äôs too much work
  18.  
  19. to localize your application for 20 different languages, so you decide to
  20.  
  21. translate only the help information.  Even if you distribute different
  22.  
  23. versions of your application for each market, you may not want to
  24.  
  25. maintain different versions of the help file, or you may want to support
  26.  
  27. two languages in each market:  the local one, and English.  Since the help
  28.  
  29. file is the first thing your users will read, language support may be
  30.  
  31. important to you.  Not only can the Help on Wheels server be localized for
  32.  
  33. other languages; it supports multilingual help files.
  34.  
  35. 
  36.  
  37. 
  38.  
  39. NOTE:  This version of Help on Wheels does not support script systems
  40.  
  41. which characteristically differ from the standard smRoman (0).  Support
  42.  
  43. for other world script systems is possible in the future.
  44.  
  45. 
  46.  
  47. 
  48.  
  49. 
  50.  
  51. xWhat Does the User See?
  52.  
  53. 
  54.  
  55. When Help on Wheels opens your help file, it follows a sequence to find the
  56.  
  57. most appropriate available language.  First, it always tries to find help
  58.  
  59. information corresponding to the current script‚Äôs current language code.
  60.  
  61. Second, failing that, it will use the language code of the server‚Äôs local
  62.  
  63. version, as specified in its own 'HoWL' resource.  Third, it will use the
  64.  
  65. default language code indicated by the client at registration.  Last, it will
  66.  
  67. try langEnglish (0).  If even that fails, the user may see an error
  68.  
  69. message, and your client will receive an error code (noMasterResErr) at
  70.  
  71. the time of registration.
  72.  
  73. 
  74.  
  75. 
  76.  
  77. To offer help in 20 languages, you can distribute 20 small help files, or
  78.  
  79. one large one.  If you use multiple files, your application is responsible for
  80.  
  81. registering the right one at startup.  If you use one file, Help on Wheels
  82.  
  83. will determine the ‚Äúright‚Äù language as above, and select one of the 20
  84.  
  85. parallel sets of resources in the help file.
  86.  
  87. 
  88.  
  89. 
  90.  
  91. 
  92.  
  93. xHow Do I Build Multilingual Help Files?
  94.  
  95. 
  96.  
  97. If you want to support 20 languages in one help file, you must write 20
  98.  
  99. help source documents, and repeat the build sequence (cvrt, wrap, Rez)
  100.  
  101. 20 times, targeting the same file each time.  Each time, you are adding a
  102.  
  103. master 'HoW!' resource, with ID equal to the language code, which points
  104.  
  105. to many other resources containing the help information.  You must use
  106.  
  107. different values for the ‚ÄúHoW‚Ķ‚Äù defined symbols for each language, to
  108.  
  109. avoid collisions among these other resources.  Naturally, when translating
  110.  
  111. the help source documents, you will use the same tag values to index the
  112.  
  113. same topics in the help file for each language.
  114.  
  115. 
  116.  
  117. 
  118.  
  119. There is a different version of the resource file HoWRez.{language}.r for
  120.  
  121. each language.  The difference between HoWRez.English.r and
  122.  
  123. HoWRez.French.r is twofold.  First, the default language code is different,
  124.  
  125. so if your help source document is in French and you build it with
  126.  
  127. HoWRez.French.r, you don‚Äôt have to define the ‚ÄúlanguageCode‚Äù symbol in
  128.  
  129. the Rez command.  Second, French will be the language of the strings in
  130.  
  131. the alerts and dialog boxes seen by the user if the help server could not be
  132.  
  133. found to display the help file.  If your help file is separate from your
  134.  
  135. application, you should define the ‚Äúapplication‚Äù or ‚Äúextension‚Äù symbol in
  136.  
  137. only one of the Rez commands, the one which builds with the main
  138.  
  139. language‚Äôs HoWRez.{language}.r file, to ensure that the Finder alert string
  140.  
  141. 'STR ' (-16397) comes up in the main language.
  142.  
  143. 
  144.  
  145. 
  146.  
  147.